home *** CD-ROM | disk | FTP | other *** search
/ Compendium Deluxe 2 / LSD and 17bit Compendium Deluxe - Volume II.iso / a / prog / misc / xes120.lha / XES / Docs / AlphaSpell.man next >
Text File  |  1994-11-09  |  5KB  |  117 lines
  1. NAME
  2.     AlphaSpell V3.00 - A Command Line Spelling Checker.
  3.  
  4. SYNOPSIS
  5.     AlphaSpell <S|C> <Dictionary1> [Dictionary2 ...]
  6.     AlphaSpell <M|R> <Dictionary>
  7.  
  8.     COMMANDS
  9.         S - Spellcheck, i.e. display unfound stdin words.
  10.         C - Common, i.e. display found stdin words.
  11.         M - Merge the dictionary words w/ the stdin words.
  12.         R - Remove, i.e. display the dictionary words minus the stdin words.
  13.  
  14. COPYRIGHT
  15.     AlphaSpell V3.00 Copyright (C) 1993 Fergus Duniho
  16.  
  17. DESCRIPTION
  18.     AlphaSpell is mainly for spellchecking and dictionary maintenance, and
  19.     it can perform a couple other tasks that were easy to implement and
  20.     might be useful.
  21.  
  22.     SPELLCHECK
  23.         Spellchecking is the main purpose of AlphaSpell. When
  24.         spellchecking, AlphaSpell extracts all the words sent to it though
  25.         standard input, translates them into lowercase, and checks them
  26.         against an alphabetized, lowercase ascii dictionary. It sends to
  27.         standard output any words which it could not find in the
  28.         dictionary. The user should then find these words in the document
  29.         that he had spellchecked and make sure these are the words he wants
  30.         to use. On the Amiga, the user may use an ARexx script I wrote for
  31.         this purpose.
  32.  
  33.     COMMON
  34.         This works like spellchecking, except that AlphaSpell sends to
  35.         standard output every word it did find. This may be useful when you
  36.         want to check for problem words in a document, such as "they're,"
  37.         "their," and "there," or "accept" and "except."
  38.  
  39.     MERGE
  40.         This requires that the file sent through standard input be an
  41.         alphabetized, lowercase ascii dictionary. It is meant for merging
  42.         two ascii dictionaries into one. E.g., you might want to merge your
  43.         user dictionary with your main dictionary.
  44.  
  45.     REMOVE
  46.         Like MERGE, this requires that the file sent through standard input
  47.         be a lowercase ascii dictionary. It sends to standard output all
  48.         the words in the dictionary except those from standard input. This
  49.         is useful for removing unwanted words from the dictionary, such as
  50.         misspellings and jargon you'll never use. Although you could
  51.         probably do this more easily with a text editor if you have enough
  52.         RAM, this feature gives people without enough RAM the same ability.
  53.  
  54.         This feature may also be used for spellchecking alphabetized lists
  55.         of words, as the original AlphaSpell did. When you use it for this
  56.         purpose, you should send the dictionary through standard input and
  57.         give the name of the file you want to spellcheck as the dictionary
  58.         name.
  59.  
  60. DETAILS
  61.  
  62.     WORDS
  63.         A word for AlphaSpell is a string of two or more letters, which may
  64.         have apostrophes inside but not at the ends. Words do not include
  65.         apostrophe-s.
  66.  
  67.         LEGAL WORDS
  68.             ain't
  69.             by
  70.             Amiga
  71.             twas
  72.  
  73.         ILLEGAL WORDS
  74.             a
  75.             'twas
  76.             Amiga's
  77.  
  78.     SPELLCHECKING METHOD
  79.         AlphaSpell spellchecks words in alphabetical order, hence its name.
  80.         As it begins to look for each word, it begins where it left off in
  81.         the dictionary. This allows it to quickly finish spellchecking by
  82.         making only a single pass through the dictionary. It can thereby
  83.         finish spellchecking in less time than it would take to load the
  84.         dictionary into memory.
  85.  
  86. HISTORY
  87.     Before AlphaSpell and before I knew C, I had written a spelling checker
  88.     in ARexx. I don't think I ever released this. But I used a similar
  89.     spellchecking algorithm in AlphaSpell.
  90.  
  91.     I wrote the first version of AlphaSpell in C when I was first trying to
  92.     learn the language back in the Spring of 1992. Its abilities were
  93.     limited because my knowledge of C was limited.
  94.  
  95.     AlphaSpell V2.00 was also in C, but I never released it. It had the
  96.     ability to use a compacted dictionary.
  97.  
  98.     AlphaSpell V3.00 is not a revision of previous versions of AlphaSpell.
  99.     It is a new and better program written from scratch in C++. It is my
  100.     first major C++ program. AlphaSpell uses the same basic algorithm for
  101.     spellchecking, but it implements it with less redundancy.
  102.  
  103.     Previous versions would load in each word from the dictionary and use
  104.     case insensitive comparison. AlphaSpell III spellchecks without loading
  105.     in each word, and it uses case sensitive comparison. Thus, it zips
  106.     through the dictionary faster than previous versions did.
  107.  
  108.     Also, AlphaSpell V3.00 does not depend upon the programs which previous
  109.     versions needed. Previous versions of AlphaSpell needed their input
  110.     prepared by the three programs getwords, sort, and uniq. AlphaSpell
  111.     V3.00 doesn't.
  112.  
  113.     Unlike AlphaSpell V2.00, the unregistered version of AlphaSpell V3.00
  114.     does not work with compacted dictionaries. But the registered version
  115.     does.
  116.  
  117.